Node / meshtastic / Meshtastic-Android / files / docs / assets / screenshots / README.md

Displaying Rendered • View raw • Download

This directory is the single source of truth for screenshot assets referenced by the

documentation pages. It is consumed by both:

• the Jekyll docs site (markdown references T383838../../assets/screenshots/{name}.png), and

• the in-app docs browser — T383838:feature:docs:syncDocsToComposeResources bundles this

directory into compose resources at T383838files/docs/assets/screenshots/.

T383838DocImageWiringTest (in T383838:feature:docs) fails the build if a doc page references an image

that is not present here.

Most screenshots are generated from the Compose Preview Screenshot Testing reference images

in T383838screenshot-tests/src/screenshotTestDebug/reference/. After changing a UI component:

T282828

./gradlew :screenshot-tests:copyDocsScreenshots T8b949e# refresh this directory

T383838copyDocsScreenshots copies only the light-mode reference images that have a semantic

alias in T383838screenshot-tests/docs-screenshot-aliases.properties, renaming them on the way.

Commit the refreshed PNGs together with the reference-image changes.

1. Add (or reuse) a T383838Preview*/T383838*Preview composable with representative mock data in the

feature module, and a T383838Screenshot* wrapper in T383838screenshot-tests (see

T383838DiscoveryScreenshotTests.kt for the pattern). If the component renders timestamps, give

it a T383838timeTextOverride-style parameter so renders stay deterministic across machines.

2. Make sure the test class is covered by T383838screenshot-tests/docs-screenshots-manifest.txt.

3. Map the semantic name in T383838screenshot-tests/docs-screenshot-aliases.properties:

T383838{page-id}_{description}.png=Screenshot{Name}_Light_{hash}_0.png

4. Run the two Gradle tasks above and reference the image from the doc page.

T282828

Examples: T383838onboarding_welcome.png, T383838connections_bluetooth_scan.png, T383838discovery_preset_result.png.

• PNG format, light-mode only (dark variants live in the reference directory)

• Name screenshots to match the docs page they appear in

• Keep filenames lowercase with underscores

• A few screenshots (T383838connections_wifi_*.png) are manual captures with no CST source yet;

they are hand-maintained until matching previews exist